<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     * <a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     * <a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.lang.enum;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.util.Iterator;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.util.List;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    import org.apache.commons.lang.ClassUtils;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    /**<a name="line.24"></a>
<FONT color="green">025</FONT>     * &lt;p&gt;Abstract superclass for type-safe enums with integer values suitable<a name="line.25"></a>
<FONT color="green">026</FONT>     * for use in &lt;code&gt;switch&lt;/code&gt; statements.&lt;/p&gt;<a name="line.26"></a>
<FONT color="green">027</FONT>     *<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;p&gt;&lt;em&gt;NOTE:&lt;/em&gt;Due to the way in which Java ClassLoaders work, comparing<a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;code&gt;Enum&lt;/code&gt; objects should always be done using the equals() method,<a name="line.29"></a>
<FONT color="green">030</FONT>     * not &lt;code&gt;==&lt;/code&gt;. The equals() method will try &lt;code&gt;==&lt;/code&gt; first so<a name="line.30"></a>
<FONT color="green">031</FONT>     * in most cases the effect is the same.&lt;/p&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     *<a name="line.32"></a>
<FONT color="green">033</FONT>     * &lt;p&gt;To use this class, it must be subclassed. For example:&lt;/p&gt;<a name="line.33"></a>
<FONT color="green">034</FONT>     *<a name="line.34"></a>
<FONT color="green">035</FONT>     * &lt;pre&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     * public final class JavaVersionEnum extends ValuedEnum {<a name="line.36"></a>
<FONT color="green">037</FONT>     *   //standard enums for version of JVM<a name="line.37"></a>
<FONT color="green">038</FONT>     *   public static final int  JAVA1_0_VALUE  = 100;<a name="line.38"></a>
<FONT color="green">039</FONT>     *   public static final int  JAVA1_1_VALUE  = 110;<a name="line.39"></a>
<FONT color="green">040</FONT>     *   public static final int  JAVA1_2_VALUE  = 120;<a name="line.40"></a>
<FONT color="green">041</FONT>     *   public static final int  JAVA1_3_VALUE  = 130;<a name="line.41"></a>
<FONT color="green">042</FONT>     *   public static final JavaVersionEnum  JAVA1_0  = new JavaVersionEnum( "Java 1.0", JAVA1_0_VALUE );<a name="line.42"></a>
<FONT color="green">043</FONT>     *   public static final JavaVersionEnum  JAVA1_1  = new JavaVersionEnum( "Java 1.1", JAVA1_1_VALUE );<a name="line.43"></a>
<FONT color="green">044</FONT>     *   public static final JavaVersionEnum  JAVA1_2  = new JavaVersionEnum( "Java 1.2", JAVA1_2_VALUE );<a name="line.44"></a>
<FONT color="green">045</FONT>     *   public static final JavaVersionEnum  JAVA1_3  = new JavaVersionEnum( "Java 1.3", JAVA1_3_VALUE );<a name="line.45"></a>
<FONT color="green">046</FONT>     *<a name="line.46"></a>
<FONT color="green">047</FONT>     *   private JavaVersionEnum(String name, int value) {<a name="line.47"></a>
<FONT color="green">048</FONT>     *     super( name, value );<a name="line.48"></a>
<FONT color="green">049</FONT>     *   }<a name="line.49"></a>
<FONT color="green">050</FONT>     * <a name="line.50"></a>
<FONT color="green">051</FONT>     *   public static JavaVersionEnum getEnum(String javaVersion) {<a name="line.51"></a>
<FONT color="green">052</FONT>     *     return (JavaVersionEnum) getEnum(JavaVersionEnum.class, javaVersion);<a name="line.52"></a>
<FONT color="green">053</FONT>     *   }<a name="line.53"></a>
<FONT color="green">054</FONT>     * <a name="line.54"></a>
<FONT color="green">055</FONT>     *   public static JavaVersionEnum getEnum(int javaVersion) {<a name="line.55"></a>
<FONT color="green">056</FONT>     *     return (JavaVersionEnum) getEnum(JavaVersionEnum.class, javaVersion);<a name="line.56"></a>
<FONT color="green">057</FONT>     *   }<a name="line.57"></a>
<FONT color="green">058</FONT>     * <a name="line.58"></a>
<FONT color="green">059</FONT>     *   public static Map getEnumMap() {<a name="line.59"></a>
<FONT color="green">060</FONT>     *     return getEnumMap(JavaVersionEnum.class);<a name="line.60"></a>
<FONT color="green">061</FONT>     *   }<a name="line.61"></a>
<FONT color="green">062</FONT>     * <a name="line.62"></a>
<FONT color="green">063</FONT>     *   public static List getEnumList() {<a name="line.63"></a>
<FONT color="green">064</FONT>     *     return getEnumList(JavaVersionEnum.class);<a name="line.64"></a>
<FONT color="green">065</FONT>     *   }<a name="line.65"></a>
<FONT color="green">066</FONT>     * <a name="line.66"></a>
<FONT color="green">067</FONT>     *   public static Iterator iterator() {<a name="line.67"></a>
<FONT color="green">068</FONT>     *     return iterator(JavaVersionEnum.class);<a name="line.68"></a>
<FONT color="green">069</FONT>     *   }<a name="line.69"></a>
<FONT color="green">070</FONT>     * }<a name="line.70"></a>
<FONT color="green">071</FONT>     * &lt;/pre&gt;<a name="line.71"></a>
<FONT color="green">072</FONT>     *<a name="line.72"></a>
<FONT color="green">073</FONT>     * &lt;p&gt;The above class could then be used as follows:&lt;/p&gt;<a name="line.73"></a>
<FONT color="green">074</FONT>     *<a name="line.74"></a>
<FONT color="green">075</FONT>     * &lt;pre&gt;<a name="line.75"></a>
<FONT color="green">076</FONT>     * public void doSomething(JavaVersionEnum ver) {<a name="line.76"></a>
<FONT color="green">077</FONT>     *   switch (ver.getValue()) {<a name="line.77"></a>
<FONT color="green">078</FONT>     *     case JAVA1_0_VALUE:<a name="line.78"></a>
<FONT color="green">079</FONT>     *       // ...<a name="line.79"></a>
<FONT color="green">080</FONT>     *       break;<a name="line.80"></a>
<FONT color="green">081</FONT>     *     case JAVA1_1_VALUE:<a name="line.81"></a>
<FONT color="green">082</FONT>     *       // ...<a name="line.82"></a>
<FONT color="green">083</FONT>     *       break;<a name="line.83"></a>
<FONT color="green">084</FONT>     *     //...<a name="line.84"></a>
<FONT color="green">085</FONT>     *   }<a name="line.85"></a>
<FONT color="green">086</FONT>     * }<a name="line.86"></a>
<FONT color="green">087</FONT>     * &lt;/pre&gt;<a name="line.87"></a>
<FONT color="green">088</FONT>     *<a name="line.88"></a>
<FONT color="green">089</FONT>     * &lt;p&gt;As shown, each enum has a name and a value. These can be accessed using<a name="line.89"></a>
<FONT color="green">090</FONT>     * &lt;code&gt;getName&lt;/code&gt; and &lt;code&gt;getValue&lt;/code&gt;.&lt;/p&gt;<a name="line.90"></a>
<FONT color="green">091</FONT>     *<a name="line.91"></a>
<FONT color="green">092</FONT>     * &lt;p&gt;The &lt;code&gt;getEnum&lt;/code&gt; and &lt;code&gt;iterator&lt;/code&gt; methods are recommended.<a name="line.92"></a>
<FONT color="green">093</FONT>     * Unfortunately, Java restrictions require these to be coded as shown in each subclass.<a name="line.93"></a>
<FONT color="green">094</FONT>     * An alternative choice is to use the {@link EnumUtils} class.&lt;/p&gt;<a name="line.94"></a>
<FONT color="green">095</FONT>     *<a name="line.95"></a>
<FONT color="green">096</FONT>     * @deprecated Replaced by {@link org.apache.commons.lang.enums.ValuedEnum org.apache.commons.lang.enums.ValuedEnum}<a name="line.96"></a>
<FONT color="green">097</FONT>     *          and will be removed in version 3.0. All classes in this package are deprecated and repackaged to <a name="line.97"></a>
<FONT color="green">098</FONT>     *          {@link org.apache.commons.lang.enums} since &lt;code&gt;enum&lt;/code&gt; is a Java 1.5 keyword. <a name="line.98"></a>
<FONT color="green">099</FONT>     * @see org.apache.commons.lang.enums.ValuedEnum<a name="line.99"></a>
<FONT color="green">100</FONT>     * @author Apache Avalon project<a name="line.100"></a>
<FONT color="green">101</FONT>     * @author Apache Software Foundation<a name="line.101"></a>
<FONT color="green">102</FONT>     * @since 1.0<a name="line.102"></a>
<FONT color="green">103</FONT>     * @version $Id: ValuedEnum.java 905636 2010-02-02 14:03:32Z niallp $<a name="line.103"></a>
<FONT color="green">104</FONT>     */<a name="line.104"></a>
<FONT color="green">105</FONT>    public abstract class ValuedEnum extends Enum {<a name="line.105"></a>
<FONT color="green">106</FONT>        <a name="line.106"></a>
<FONT color="green">107</FONT>        /**<a name="line.107"></a>
<FONT color="green">108</FONT>         * Required for serialization support. Lang version 1.0.1 serial compatibility.<a name="line.108"></a>
<FONT color="green">109</FONT>         * <a name="line.109"></a>
<FONT color="green">110</FONT>         * @see java.io.Serializable<a name="line.110"></a>
<FONT color="green">111</FONT>         */<a name="line.111"></a>
<FONT color="green">112</FONT>        private static final long serialVersionUID = -7129650521543789085L;<a name="line.112"></a>
<FONT color="green">113</FONT>        <a name="line.113"></a>
<FONT color="green">114</FONT>        /**<a name="line.114"></a>
<FONT color="green">115</FONT>         * The value contained in enum.<a name="line.115"></a>
<FONT color="green">116</FONT>         */<a name="line.116"></a>
<FONT color="green">117</FONT>        private final int iValue;<a name="line.117"></a>
<FONT color="green">118</FONT>    <a name="line.118"></a>
<FONT color="green">119</FONT>        /**<a name="line.119"></a>
<FONT color="green">120</FONT>         * Constructor for enum item.<a name="line.120"></a>
<FONT color="green">121</FONT>         *<a name="line.121"></a>
<FONT color="green">122</FONT>         * @param name  the name of enum item<a name="line.122"></a>
<FONT color="green">123</FONT>         * @param value  the value of enum item<a name="line.123"></a>
<FONT color="green">124</FONT>         */<a name="line.124"></a>
<FONT color="green">125</FONT>        protected ValuedEnum(String name, int value) {<a name="line.125"></a>
<FONT color="green">126</FONT>            super(name);<a name="line.126"></a>
<FONT color="green">127</FONT>            iValue = value;<a name="line.127"></a>
<FONT color="green">128</FONT>        }<a name="line.128"></a>
<FONT color="green">129</FONT>    <a name="line.129"></a>
<FONT color="green">130</FONT>        /**<a name="line.130"></a>
<FONT color="green">131</FONT>         * &lt;p&gt;Gets an &lt;code&gt;Enum&lt;/code&gt; object by class and value.&lt;/p&gt;<a name="line.131"></a>
<FONT color="green">132</FONT>         *<a name="line.132"></a>
<FONT color="green">133</FONT>         * &lt;p&gt;This method loops through the list of &lt;code&gt;Enum&lt;/code&gt;,<a name="line.133"></a>
<FONT color="green">134</FONT>         * thus if there are many &lt;code&gt;Enum&lt;/code&gt;s this will be<a name="line.134"></a>
<FONT color="green">135</FONT>         * slow.&lt;/p&gt;<a name="line.135"></a>
<FONT color="green">136</FONT>         * <a name="line.136"></a>
<FONT color="green">137</FONT>         * @param enumClass  the class of the &lt;code&gt;Enum&lt;/code&gt; to get<a name="line.137"></a>
<FONT color="green">138</FONT>         * @param value  the value of the &lt;code&gt;Enum&lt;/code&gt; to get<a name="line.138"></a>
<FONT color="green">139</FONT>         * @return the enum object, or null if the enum does not exist<a name="line.139"></a>
<FONT color="green">140</FONT>         * @throws IllegalArgumentException if the enum class is &lt;code&gt;null&lt;/code&gt;<a name="line.140"></a>
<FONT color="green">141</FONT>         */<a name="line.141"></a>
<FONT color="green">142</FONT>        protected static Enum getEnum(Class enumClass, int value) {<a name="line.142"></a>
<FONT color="green">143</FONT>            if (enumClass == null) {<a name="line.143"></a>
<FONT color="green">144</FONT>                throw new IllegalArgumentException("The Enum Class must not be null");<a name="line.144"></a>
<FONT color="green">145</FONT>            }<a name="line.145"></a>
<FONT color="green">146</FONT>            List list = Enum.getEnumList(enumClass);<a name="line.146"></a>
<FONT color="green">147</FONT>            for (Iterator it = list.iterator(); it.hasNext();) {<a name="line.147"></a>
<FONT color="green">148</FONT>                ValuedEnum enumeration = (ValuedEnum) it.next();<a name="line.148"></a>
<FONT color="green">149</FONT>                if (enumeration.getValue() == value) {<a name="line.149"></a>
<FONT color="green">150</FONT>                    return enumeration;<a name="line.150"></a>
<FONT color="green">151</FONT>                }<a name="line.151"></a>
<FONT color="green">152</FONT>            }<a name="line.152"></a>
<FONT color="green">153</FONT>            return null;<a name="line.153"></a>
<FONT color="green">154</FONT>        }<a name="line.154"></a>
<FONT color="green">155</FONT>    <a name="line.155"></a>
<FONT color="green">156</FONT>        /**<a name="line.156"></a>
<FONT color="green">157</FONT>         * &lt;p&gt;Get value of enum item.&lt;/p&gt;<a name="line.157"></a>
<FONT color="green">158</FONT>         *<a name="line.158"></a>
<FONT color="green">159</FONT>         * @return the enum item's value.<a name="line.159"></a>
<FONT color="green">160</FONT>         */<a name="line.160"></a>
<FONT color="green">161</FONT>        public final int getValue() {<a name="line.161"></a>
<FONT color="green">162</FONT>            return iValue;<a name="line.162"></a>
<FONT color="green">163</FONT>        }<a name="line.163"></a>
<FONT color="green">164</FONT>    <a name="line.164"></a>
<FONT color="green">165</FONT>        /**<a name="line.165"></a>
<FONT color="green">166</FONT>         * &lt;p&gt;Tests for order.&lt;/p&gt;<a name="line.166"></a>
<FONT color="green">167</FONT>         *<a name="line.167"></a>
<FONT color="green">168</FONT>         * &lt;p&gt;The default ordering is numeric by value, but this<a name="line.168"></a>
<FONT color="green">169</FONT>         * can be overridden by subclasses.&lt;/p&gt;<a name="line.169"></a>
<FONT color="green">170</FONT>         * <a name="line.170"></a>
<FONT color="green">171</FONT>         * @see java.lang.Comparable#compareTo(Object)<a name="line.171"></a>
<FONT color="green">172</FONT>         * @param other  the other object to compare to<a name="line.172"></a>
<FONT color="green">173</FONT>         * @return -ve if this is less than the other object, +ve if greater than,<a name="line.173"></a>
<FONT color="green">174</FONT>         *  &lt;code&gt;0&lt;/code&gt; of equal<a name="line.174"></a>
<FONT color="green">175</FONT>         * @throws ClassCastException if other is not an &lt;code&gt;Enum&lt;/code&gt;<a name="line.175"></a>
<FONT color="green">176</FONT>         * @throws NullPointerException if other is &lt;code&gt;null&lt;/code&gt;<a name="line.176"></a>
<FONT color="green">177</FONT>         */<a name="line.177"></a>
<FONT color="green">178</FONT>        public int compareTo(Object other) {<a name="line.178"></a>
<FONT color="green">179</FONT>            return iValue - ((ValuedEnum) other).iValue;<a name="line.179"></a>
<FONT color="green">180</FONT>        }<a name="line.180"></a>
<FONT color="green">181</FONT>    <a name="line.181"></a>
<FONT color="green">182</FONT>        /**<a name="line.182"></a>
<FONT color="green">183</FONT>         * &lt;p&gt;Human readable description of this &lt;code&gt;Enum&lt;/code&gt; item.&lt;/p&gt;<a name="line.183"></a>
<FONT color="green">184</FONT>         *<a name="line.184"></a>
<FONT color="green">185</FONT>         * @return String in the form &lt;code&gt;type[name=value]&lt;/code&gt;, for example:<a name="line.185"></a>
<FONT color="green">186</FONT>         *  &lt;code&gt;JavaVersion[Java 1.0=100]&lt;/code&gt;. Note that the package name is<a name="line.186"></a>
<FONT color="green">187</FONT>         *  stripped from the type name.<a name="line.187"></a>
<FONT color="green">188</FONT>         */<a name="line.188"></a>
<FONT color="green">189</FONT>        public String toString() {<a name="line.189"></a>
<FONT color="green">190</FONT>            if (iToString == null) {<a name="line.190"></a>
<FONT color="green">191</FONT>                String shortName = ClassUtils.getShortClassName(getEnumClass());<a name="line.191"></a>
<FONT color="green">192</FONT>                iToString = shortName + "[" + getName() + "=" + getValue() + "]";<a name="line.192"></a>
<FONT color="green">193</FONT>            }<a name="line.193"></a>
<FONT color="green">194</FONT>            return iToString;<a name="line.194"></a>
<FONT color="green">195</FONT>        }<a name="line.195"></a>
<FONT color="green">196</FONT>    }<a name="line.196"></a>




























































</PRE>
</BODY>
</HTML>
